Alfresco Index of Web Scripts URI '/api/sites/{shortname}/invitations'
Alfresco Community v3.2.0 (2039)
2 Web Scripts

Back to Web Scripts Home

Up to uri /api/sites/{shortname}

/api/sites/{shortname}/invitations/{invitationId}
/api/sites/{shortname}/invitations/{inviteId}

Create invitation for web site
POST /alfresco/service/api/sites/{shortname}/invitations
Description:Create a new invitation for this web site.
For a Nominated Invitation, where an existing site member nominates someone else who is possibly not yet an alfresco user to become a member of this web site.
For an existing user, the invitee is identified by inviteeUserName. For a user who does not have a userName a new account will be generated based upon inviteeFirstName, inviteeLastName and inviteeEmail
if inviteeUserName is specified then inviteeFirstName, inviteeLastName and inviteeEmail are ignored.
invitationType
mandatory - "NOMINATED"
inviteeFirstName
optional,
inviteeLastName
optional,
inviteeEmail
optional,
inviteeUserName
optional
serverPath
acceptURL
rejectURL
inviteeRoleName
mandatory what role to be given on this web site

For a Moderated Invitation, where an existing user wants to be made a member of a moderated web site.
invitationType
mandatory - "MODERATED"
inviteeUserName
optional who wants to be invited to this web site?
inviteeComments
mandatory (but can be blank) why do they want membership to this site ?
inviteeRoleName
mandatory what role to be given on this web site

Returns HTTPStatus.Created (201) if an invitation is created.
Authentication:user
Transaction:required
Format Style:any
Lifecycle:draft_public_api
Default Format:json
Id:org/alfresco/repository/site/invitation/invitation.post
Description:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitation.post.desc.xml

List Invitations
GET /alfresco/service/api/sites/{shortname}/invitations?inviteeUserName={inviteeUserName?}&invitationType={invitationType?}
Description:Get a collecton of a site web invitations.
With no parameters, returns all open invitations for this web site.
With inviteeUserName, returns all open invitations for this web site and invitee.
With invitationType, returns all open invitations of the specified type (Either NOMINATED or MODERATED).
Returns a JSON element
Authentication:user
Transaction:required
Format Style:any
Lifecycle:draft_public_api
Default Format:json
Id:org/alfresco/repository/site/invitation/invitations.get
Description:classpath:alfresco/templates/webscripts/org/alfresco/repository/site/invitation/invitations.get.desc.xml